Class IPsProcessImpl

All Implemented Interfaces:
IPCObject, IPsProcess, Process

public class IPsProcessImpl extends ProcessImpl implements IPsProcess
Information provided by the PKI file:

    \class IpsProcess
    
    \brief IpsProcess is the process that handles intrusion prevention.
    
    \example network().getDevice("Router0").getProcess("IpsProcess")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setConfigLocation

      public void setConfigLocation(String name)
      Information provided by the PKI file:
      
          \brief Sets the directory location.
          
          \param name, the directory location.
          
              
      Specified by:
      setConfigLocation in interface IPsProcess
      Parameters:
      name - Takes in a parameter of name
    • getConfigLocation

      public String getConfigLocation()
      Information provided by the PKI file:
      
          \brief Returns the config location directory for IPS.
          
          \return string, the config location directory for IPS.
          
              
      Specified by:
      getConfigLocation in interface IPsProcess
      Returns:
      String Returns a String
    • getIpsAt

      public String getIpsAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the IPS at the specified index.
          
          \param index, the index of the IPS of interest.
          
          \return string, the IPS at the specified index.
          
              
      Specified by:
      getIpsAt in interface IPsProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • getAclForIps

      public String getAclForIps(String ipsName)
      Information provided by the PKI file:
      
          \brief Returns the ACL for the IPS with the specified name.
          
          \param ipsName, the name of the IPS of interest.
          
          \return string, the ACL for the IPS with the specified name.
          
              
      Specified by:
      getAclForIps in interface IPsProcess
      Parameters:
      ipsName - Takes in a parameter of ipsName
      Returns:
      String Returns a String
    • addIps

      public void addIps(String ipsName, String aclName)
      Information provided by the PKI file:
      
          \brief Adds an IPS with the specified name and ACL.
          
          \param ipsName, the name of this IPS.
          \param aclName, the name of the ACL for this IPS.
          
              
      Specified by:
      addIps in interface IPsProcess
      Parameters:
      ipsName - Takes in a parameter of ipsName
      aclName - Takes in a parameter of aclName
    • deleteIps

      public boolean deleteIps(String ipsName)
      Information provided by the PKI file:
      
          \brief Removes the IPS from the list.
          
          \param ipsName, the name of the IPS of interest.
          
          \returns bool, true if successful, otherwise false.
          
              
      Specified by:
      deleteIps in interface IPsProcess
      Parameters:
      ipsName - Takes in a parameter of ipsName
      Returns:
      boolean Returns a boolean
    • getIpsListSize

      public int getIpsListSize()
      Information provided by the PKI file:
      
          \brief Returns the number of IPS configured.
          
          \return int, the number of IPS configured.
          
              
      Specified by:
      getIpsListSize in interface IPsProcess
      Returns:
      int Returns a int
    • getRootSigCategory

      public SignatureCategory getRootSigCategory()
      Information provided by the PKI file:
      
          \brief Returns the root signature category category.
          
          \return SignatureCategory, the SignatureCategory object.
          
              
      Specified by:
      getRootSigCategory in interface IPsProcess
      Returns:
      SignatureCategory Returns a SignatureCategory
    • getSubCategoryAt

      public Category getSubCategoryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the subcategory at the specified index.
          
          \param index, the index of the subcategory of interest.
          
          \return Category, the Category object at the specified index.
          
              
      Specified by:
      getSubCategoryAt in interface IPsProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Category Returns a Category
    • getSubCategorySize

      public int getSubCategorySize()
      Information provided by the PKI file:
      
          \brief Returns the subcategory size.
          
          \return int, the subcategory size.
          
              
      Specified by:
      getSubCategorySize in interface IPsProcess
      Returns:
      int Returns a int
    • getIcmpSignature

      public ICMPSignature getIcmpSignature()
      Information provided by the PKI file:
      
          \brief Returns the ICMP signature.
          
          \return IcmpSignature, the IcmpSignature object.
          
              
      Specified by:
      getIcmpSignature in interface IPsProcess
      Returns:
      ICMPSignature Returns a ICMPSignature
    • setRetryCount

      public void setRetryCount(int count)
      Information provided by the PKI file:
      
          \brief Sets the retry count.
          
          \param count, the retry count.
          
              
      Specified by:
      setRetryCount in interface IPsProcess
      Parameters:
      count - Takes in a parameter of count
    • getRetryCount

      public int getRetryCount()
      Information provided by the PKI file:
      
          \brief Returns the retry count
          
          \return int, the retry count.
          
              
      Specified by:
      getRetryCount in interface IPsProcess
      Returns:
      int Returns a int
    • setNotifyLog

      public void setNotifyLog(boolean val)
      Information provided by the PKI file:
      
          \brief Sets the syslog notification.
          
          \param val, true to enable syslog, false to disable it.
          
              
      Specified by:
      setNotifyLog in interface IPsProcess
      Parameters:
      val - Takes in a parameter of val
    • isSysLogEnabled

      public boolean isSysLogEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if syslog is enabled, otherwise false.
          
          \return bool, true if syslog is enabled, otherwise false.
          
              
      Specified by:
      isSysLogEnabled in interface IPsProcess
      Returns:
      boolean Returns a boolean